<meta charset="utf-8">
(#) <Never used>

!!! ERROR: <Never used>
   This is an error.

Id
:   `DoNotMock`
Summary
:   <Never used>
Severity
:   Error
Category
:   Correctness
Platform
:   Any
Vendor
:   slack
Identifier
:   slack-lint
Contact
:   https://github.com/slackhq/slack-lints
Feedback
:   https://github.com/slackhq/slack-lints
Min
:   Lint 8.7+
Compiled
:   Lint 8.7+
Artifact
:   [com.slack.lint:slack-lint-checks](com_slack_lint_slack-lint-checks.md.html)
Since
:   0.1.0
Affects
:   Kotlin and Java files and test sources
Editing
:   This check runs on the fly in the IDE editor
Implementation
:   [Source Code](https://github.com/slackhq/slack-lints/tree/main/slack-lint-checks/src/main/java/slack/lint/mocking/MockDetector.kt)
Tests
:   [Source Code](https://github.com/slackhq/slack-lints/tree/main/slack-lint-checks/src/test/java/slack/lint/mocking/DoNotMockMockDetectorTest.kt)
Copyright Year
:   2021

Do not mock classes annotated with `@DoNotMock`, as they are explicitly
asking not to be mocked in favor of better options (test fakes, etc).
These types should define explanations/alternatives in their
annotation.

(##) Options

You can configure this lint checks using the following options:

(###) mock-annotations

A comma-separated list of mock annotations..
This property should define comma-separated list of mock annotation class names (FQCN). Set this for all issues using this option.

Default is "org.mockito.Mock,org.mockito.Spy".

Example `lint.xml`:

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
&lt;lint&gt;
    &lt;issue id="DoNotMock"&gt;
        &lt;option name="mock-annotations" value=""org.mockito.Mock,org.mockito.Spy"" /&gt;
    &lt;/issue&gt;
&lt;/lint&gt;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

(###) mock-factories

A comma-separated list of mock factories (org.mockito.Mockito#methodName)..
A comma-separated list of mock factories (org.mockito.Mockito#methodName). Set this for all issues using this option.

Default is "org.mockito.Mockito#mock,org.mockito.Mockito#spy,slack.test.mockito.MockitoHelpers#mock,slack.test.mockito.MockitoHelpersKt#mock".

Example `lint.xml`:

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
&lt;lint&gt;
    &lt;issue id="DoNotMock"&gt;
        &lt;option name="mock-factories" value=""org.mockito.Mockito#mock,org.mockito.Mockito#spy,slack.test.mockito.MockitoHelpers#mock,slack.test.mockito.MockitoHelpersKt#mock"" /&gt;
    &lt;/issue&gt;
&lt;/lint&gt;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

(###) mock-report

If enabled, writes a mock report to <project-dir>/build/reports/mockdetector/mock-report.csv..
If enabled, writes a mock report to <project-dir>/build/reports/mockdetector/mock-report.csv. The format of the file is a csv of (type,isError) of mocked classes. Set this for all issues using this option.

Default is "none".

Example `lint.xml`:

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
&lt;lint&gt;
    &lt;issue id="DoNotMock"&gt;
        &lt;option name="mock-report" value=""none"" /&gt;
    &lt;/issue&gt;
&lt;/lint&gt;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
test/test/slack/test/TestClass.kt:6:Error: Do not mock TestClass: Use
fake() [DoNotMock]
  @Mock lateinit var mock1: TestClass
  -----------------------------------
test/test/slack/test/TestClass.kt:7:Error: Do not mock TestClass2: Use
fake() [DoNotMock]
  @Mock lateinit var mock2: TestClass2
  ------------------------------------
test/test/slack/test/TestClass.kt:8:Error: Do not mock TestClass3:
BECAUSE REASONS [DoNotMock]
  @Mock lateinit var mock3: TestClass3
  ------------------------------------
test/test/slack/test/TestClass.kt:9:Error: Do not mock TestClass4:
BECAUSE REASONS [DoNotMock]
  @Mock lateinit var mock4: TestClass4
  ------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here are the relevant source files:

`test/test/slack/test/TestClass.kt`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers
package slack.test

@slack.lint.annotations.DoNotMock("Use fake()")
interface TestClass {
  fun fake(): TestClass? = null
}

@com.google.errorprone.annotations.DoNotMock("Use fake()")
interface TestClass2 {
  fun fake(): TestClass2? = null
}

@slack.lint.annotations.DoNotMock
interface TestClass3 {
  fun fake(): TestClass3? = null
}

@com.google.errorprone.annotations.DoNotMock
interface TestClass4 {
  fun fake(): TestClass4? = null
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`test/test/slack/test/TestClass.kt`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers
package slack.test

import org.mockito.Mock

class MyTests {
  @Mock lateinit var mock1: TestClass
  @Mock lateinit var mock2: TestClass2
  @Mock lateinit var mock3: TestClass3
  @Mock lateinit var mock4: TestClass4
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://github.com/slackhq/slack-lints/tree/main/slack-lint-checks/src/test/java/slack/lint/mocking/DoNotMockMockDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

The above example was automatically extracted from the first unit test
found for this lint check, `MockDetector.kotlinTests`.
To report a problem with this extracted sample, visit
https://github.com/slackhq/slack-lints.

(##) Including

!!!
   This is not a built-in check. To include it, add the below dependency
   to your project. This lint check is included in the lint documentation,
   but the Android team may or may not agree with its recommendations.

```
// build.gradle.kts
lintChecks("com.slack.lint:slack-lint-checks:0.8.2")

// build.gradle
lintChecks 'com.slack.lint:slack-lint-checks:0.8.2'

// build.gradle.kts with version catalogs:
lintChecks(libs.slack.lint.checks)

# libs.versions.toml
[versions]
slack-lint-checks = "0.8.2"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
slack-lint-checks = {
    module = "com.slack.lint:slack-lint-checks",
    version.ref = "slack-lint-checks"
}
```

0.8.2 is the version this documentation was generated from;
there may be newer versions available.

[Additional details about com.slack.lint:slack-lint-checks](com_slack_lint_slack-lint-checks.md.html).
(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Using a suppression annotation like this on the enclosing
  element:

  ```kt
  // Kotlin
  @Suppress("DoNotMock")
  fun method() {
     problematicStatement()
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("DoNotMock")
  void method() {
     problematicStatement();
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection DoNotMock
  problematicStatement()
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="DoNotMock" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'DoNotMock'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore DoNotMock ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>